<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC
    "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
    "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
<html xmlns:svg='http://www.w3.org/2000/svg' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
<head><meta content='application/xhtml+xml;charset=utf-8' http-equiv='Content-type' /><title>ClickClick Project</title></head>
<body>
<h1 id='clickclick_project'>ClickClick Project</h1>

<p>ClickClick is a community based extensions project for the Click Framework.</p>

<p>The aim of this project is to lower the barrier-to-entry on contributions made by Click users. Contributions can include new <code>Controls</code>, <code>Modules</code>, examples and experimental features.</p>

<h2 id='project_structure'>Project structure</h2>

<p>Each module and control set has an example web application.</p>

<p>The following modules/control sets are available:</p>

<ul>
<li><code>[core]</code> - base extensions, required by all other modules and controls in this project</li>

<li><code>[core-examples]</code> - example usage and experimental features for the above module</li>
</ul>

<p>Other directories:</p>

<ul>
<li><code>[dist]</code> - build distribution directory</li>

<li><code>[documentation]</code> - all documentation (javadocs too)</li>

<li><code>[lib]</code> - libraries downloaded automatically with get-deps task.</li>
</ul>

<h2 id='dependencies'>Dependencies</h2>

<p>The following JARs need to be present in the <code>[lib]</code> directory:</p>

<ul>
<li>click-core-2.1.0.jar</li>

<li>click-extras-2.1.0.jar</li>

<li>clickclick-core-0.1.jar</li>

<li>servlet-api-2.3.jar</li>

<li>log4j-1.2.14.jar</li>

<li>commons-lang-2.4.jar</li>
</ul>

<h2 id='building'>Building</h2>

<p>To build clickclick, execute the following steps:</p>

<ol>
<li>
<p>get all dependencies (and download manually to the /lib directory those jars not found in Maven repo), by running:</p>

<blockquote>
<p>ant get-deps</p>
</blockquote>
(also build the Click jars from trunk if they aren't released yet: see <a href="http://click.apache.org/docs/developer-guide/building.html"> Building Click Framework</a>)
</li>

<li>
<p>build all modules, controls sets, examples, by running:</p>

<blockquote>
<p>ant build-all</p>
</blockquote>
</li>

<li>
<p>(optional) build source packages</p>

<blockquote>
<p>ant build-sources</p>
</blockquote>
</li>

<li>
<p>(optional) build the entire distribution</p>

<blockquote>
<p>ant build-dist</p>
</blockquote>
</li>
</ol>
<h2 id='feedback'>Feedback</h2>
For questions and suggestions, please use the Click Framework official 
<a href="http://click.apache.org/docs/click-online.html#mailing-lists">mailing lists</a>,
by prefixing the subject of your message with <code>[ClickClick]</code>.</p>

</body></html>
